Skip to main content
POST
/
v1
/
inventory
/
holds
/
lot
/
{lot_id}
/
release
Release all active Holds on Lot
curl --request POST \
  --url https://{base_url_domain}/api/global/v1/inventory/holds/lot/{lot_id}/release \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "release_cascaded": false
}
'
{
  "lot_id": 123,
  "released_hold_ids": [
    123
  ]
}

Authorizations

​
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

​
lot_id
integer<int64>
required

Lot whose holds to release.

Body

application/json
​
release_cascaded
boolean
default:false

Only false is currently supported. Sending true returns 400 with a pointer to the per-id release endpoint.

Response

Lot release outcome.

​
lot_id
integer<int64>
required

Lot whose holds were targeted by this release call.

​
released_hold_ids
integer<int64>[]
required

Hold IDs newly released by this call. Empty when the lot had no active holds.